home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / pmake / doc / index / tmac.index < prev   
Encoding:
Text File  |  1989-11-15  |  2.0 KB  |  74 lines
  1. '\"
  2. '\" Nice macros to have.
  3. '\" To install an entry in the index, use
  4. '\"
  5. '\" .Ix <index number> { def | ref } <entry>
  6. '\"
  7. '\" (Ix == IndeX) The first argument should be "def" if it is the definition
  8. '\" of the entry (the main reference point for it) and "ref" if it is merely
  9. '\" a reference to the concept. Each entry may be composed of up to four
  10. '\" parts. The index will be sorted on each part in turn. I.e. given
  11. '\" .Ix def "Definitions" "RootWindow"
  12. '\" .Ix def "Definitions" "Tile"
  13. '\" .Ix def "Data"
  14. '\"
  15. '\" The index will look like this:
  16. '\"    Data <reference-list>
  17. '\"    Definitions
  18. '\"        Tile <reference-list>
  19. '\"        RootWindow <reference-list>
  20. '\"
  21. '\" Any number of indices may be created. Each will be sorted and printed
  22. '\" separately. To give a title to a particular index, use
  23. '\"
  24. '\" .Tx <index number> <title>
  25. '\"
  26. '\" An untitled index's title defaults to "Index".
  27. '\"
  28. '\"
  29. '\" To note a reference to a section, use
  30. '\"
  31. '\" .Rm <reference-number> <section-number>
  32. '\"
  33. '\" Where <reference-number> is a number you've assigned to the reference.
  34. '\" When you get to the section in question, use
  35. '\"
  36. '\" .Rd <reference-number>
  37. '\"
  38. '\" Mismatching section numbers will be flagged.
  39. '\"
  40. '\"    $Id: tmac.index,v 1.3 89/01/08 17:56:07 adam Exp $
  41. '\"
  42. .de Ix
  43. .if \\n(.$==6 \!X ENTRY \\n% \\$1 \\$2 "\\$3" "\\$4" "\\$5" "\\$6"
  44. .if \\n(.$==5 \!X ENTRY \\n% \\$1 \\$2 "\\$3" "\\$4" "\\$5"
  45. .if \\n(.$==4 \!X ENTRY \\n% \\$1 \\$2 "\\$3" "\\$4"
  46. .if \\n(.$==3 \!X ENTRY \\n% \\$1 \\$2 "\\$3"
  47. .if \\n(.$<=2 .tm Missing arguments for Ix, line \\n(.c
  48. ..
  49. .de Tx
  50. .ie \\n(.$!=2 .tm Improper Tx usage on line \\n(.c
  51. .el \!X TITLE \\$1 \\$2
  52. ..
  53. .de Rm
  54. \!X REF \\n(.c \\$1 \\$2
  55. ..
  56. .de Rd
  57. \!X DEF \\n(.c \\$1 \\*(SN
  58. ..
  59. .am EM
  60. .ec 
  61. .if !""*(LH" \!X HL *(LH
  62. .if !""*(CH" \!X HC *(CH
  63. .if !""*(RH" \!X HR *(RH
  64. .if !""*(LF" \!X FL *(LF
  65. .if !""*(CF" \!X FC *(CF
  66. .if !""*(RF" \!X FR *(RF
  67. .if !""*(O1" \!X HO *(O1
  68. .if !""*(E2" \!X HE *(E2
  69. .if !""*(O3" \!X FO *(O3
  70. .if !""*(E4" \!X FE *(E4
  71. \!X PN n%
  72. .ec \\
  73. ..
  74.